Introduction (example)
Welcome to the Alaunus API! You can use our API to access Alaunus API endpoints, which can get information on stuff in our database.
We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
Authentication (example)
To authorize, use this code:
require 'Kittn'
api = Kittn::APIClient.authorize!('meowmeowmeow')
import kittn
api = kittn.authorize('meowmeowmeow')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: meowmeowmeow"
const kittn = require('kittn');
let api = kittn.authorize('meowmeowmeow');
Make sure to replace
meowmeowmeowwith your API key.
Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.
Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:
Authorization: meowmeowmeow
Patients (example)
Patients section:
require 'Kittn'
api = Kittn::APIClient.authorize!('meowmeowmeow')
import kittn
api = kittn.authorize('meowmeowmeow')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: meowmeowmeow"
const kittn = require('kittn');
let api = kittn.authorize('meowmeowmeow');
test
Kittens (example)
Get All Kittens (example)
dasdastens
require 'kittn'
api = Kittn::APIClient.authorize!('meowmeowmeow')
api.kittens.get
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get()
curl "http://example.com/api/kittens"
-H "Authorization: meowmeowmeow"
const kittn = require('kittn');
let api = kittn.authorize('meowmeowmeow');
let kittens = api.kittens.get();
The above command returns JSON structured like this:
[
{
"id": 1,
"name": "Fluffums",
"breed": "calico",
"fluffiness": 6,
"cuteness": 7
},
{
"id": 2,
"name": "Max",
"breed": "unknown",
"fluffiness": 5,
"cuteness": 10
}
]
This endpoint retrieves all kittens.
HTTP Request
GET http://example.com/api/kittens
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| include_cats | false | If set to true, the result will also include cats. |
| available | true | If set to false, the result will include kittens that have already been adopted. |
Get a Specific Kitten (example)
require 'kittn'
api = Kittn::APIClient.authorize!('meowmeowmeow')
api.kittens.get(2)
import kittn
api = kittn.authorize('meowmeowmeow')
api.kittens.get(2)
curl "http://example.com/api/kittens/2"
-H "Authorization: meowmeowmeow"
const kittn = require('kittn');
let api = kittn.authorize('meowmeowmeow');
let max = api.kittens.get(2);
The above command returns JSON structured like this:
{
"id": 2,
"name": "Max",
"breed": "unknown",
"fluffiness": 5,
"cuteness": 10
}
This endpoint retrieves a specific kitten.
HTTP Request
GET http://example.com/kittens/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the kitten to retrieve |
Accounts
The accounts object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Candidates
The candidates object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Clients
The clients object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Contacts
The contacts object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Conversations
The conversations object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Events
The events object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Eventsgroups
The eventsgroups object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Files
The files object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Invoices
The invoices object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Patients
The patients object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Patientsprogressnotes
The patientsprogressnotes object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payments
The payments object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payrolls
The payrolls object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Payrollsusers
The payrollsusers object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Punchcards
The punchcards object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Skills
The skills object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Tags
The tags object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Users
The users object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'
Usersnotes
The usersnotes object
Attributes:
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
-H 'Authorization: key'